Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

instancetype: Separate docs and give ownership to sub-project #827

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lyarwood
Copy link
Member

@lyarwood lyarwood commented Aug 16, 2024

/cc @aburdenthehand
/cc @0xFelix
/cc @vladikr

What this PR does / why we need it:

I'd like to rework the instance type docs quite extensively during the 1.4 cycle. Ahead of this it would be useful if we could give ownership of the docs to the instance type sub-project approvers as has already happened with the code within KubeVirt itself.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #818

Special notes for your reviewer:

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Release note:

NONE

@kubevirt-bot kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Aug 16, 2024
@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign phoracek for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@0xFelix 0xFelix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea!

/lgtm

@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Aug 19, 2024
@0xFelix
Copy link
Member

0xFelix commented Aug 28, 2024

@phoracek PTAL, thanks!

@phoracek
Copy link
Member

@lyarwood I fully support and appreciate you owning your part of the user-guide. However, would you please split the part where you introduce a new subsection of "User Workloads" page from the OWNERS change? It may require you to explicitly list all the files your group owns instead of having a convenient subdirectory.

I would like @aburdenthehand to review the change to the structure, and that may take a while. Personally, I don't like that it adds another layer to the menu, but perhaps we can make it work.

@kubevirt-bot
Copy link
Contributor

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@kubevirt-bot kubevirt-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Aug 28, 2024
@kubevirt-bot
Copy link
Contributor

Pull requests that are marked with lgtm should receive a review
from an approver within 1 week.

After that period the bot marks them with the label needs-approver-review.

/label needs-approver-review

@kubevirt-bot
Copy link
Contributor

@kubevirt-bot: The label(s) needs-approver-review cannot be applied, because the repository doesn't have them.

In response to this:

Pull requests that are marked with lgtm should receive a review
from an approver within 1 week.

After that period the bot marks them with the label needs-approver-review.

/label needs-approver-review

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@dhiller dhiller added the needs-approver-review Indicates that a PR requires a review from an approver. label Sep 23, 2024
@aburdenthehand
Copy link
Contributor

+1 to Petr's comment. Especially the taking ownership of content 🎉
Are you planning on adding a lot of content? Like, does it make more sense to put this at the same level as 'Workloads' and 'Monitoring'? That gets the same sensible ownership of the directory but without the nested level in the TOC.

Would there be any other content from this section that would make sense to group together with instancetypes, that compute/instancetypes would own? (I ask because I wondered if something like 'Presets' would be a useful section name so that it also draws the attention of folks that aren't familiar with instancetypes as a term, so I might expect to see presets and templates also be pulled into that box.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm Indicates that a PR is ready to be merged. needs-approver-review Indicates that a PR requires a review from an approver. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/S
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Break up instance type documentation
6 participants